home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 18 / Mac Magazin and MacEasy Magazine CD - Issue 18.iso / Spiele & Edutainment / Marathon Goodies / OPEv1.4 folder / OPE ReadMe next >
Text File  |  1995-12-30  |  15KB  |  337 lines
  1. Object Placement Editor v1.4
  2. December 31, 1995      HAPPY NEW YEAR!
  3. By Eric Bennett (ericb@psu.edu)
  4.  
  5.  
  6. ==============================================================================
  7. What's New in 1.4
  8. ==============================================================================
  9.  
  10. - Open file ---> try to load file but run out of memory ---> never close file!
  11.   This is now fixed.
  12.  
  13. - New search for levels algorithm: faster and should not report incorrect
  14.   level names for maps edited with Mia! & Pfhorte.  A side effect is that
  15.   OPE can't process M2 map files, but you should use DOPE for that anyway.
  16.   
  17. - Previous version sometimes allowed selecting "close" from the file menu when
  18.   nothing was open, corrupting memory.
  19.  
  20. - If you were still using version 1.3 (the previous official release, although
  21.   1.32b has been available for almost six months), be sure to read the section
  22.   on set files, which will be new to you and perhaps even useful.
  23.   
  24.  
  25.  
  26. ==============================================================================
  27. General
  28. ==============================================================================
  29.  
  30. Have you played Marathon over the network enough times that you're sick
  31. of seeing the same aliens repeatedly?  This program allows you to change:
  32.  
  33. -how many aliens/objects of each type are initially present on a level
  34. -how many aliens/objects of each type are present during play
  35. -whether aliens/objects are placed randomly or in specific locations
  36. -how often aliens are replenished
  37.  
  38. OPE includes a randomizer for quickly resetting all of the above parameters
  39. for any given level (it still needs improvements, but it does work in its
  40. own crude way).
  41.  
  42. Although these changes are primarily useful for modifying net play, you can
  43. also use this program as a cheater in the regular game by adding objects
  44. or removing aliens.
  45.  
  46. ==============================================================================
  47. License and (lack of) Warranty
  48. ==============================================================================
  49.  
  50. This program is freeware.  You don't owe me anything for OPE, but distribution
  51. is restricted as described in the next section.
  52.  
  53. The author (Eric Bennett) in no way warrants that the program will perform
  54. as described in this manual (or any other document).  USE THIS SOFTWARE
  55. AT YOUR OWN RISK!
  56.  
  57.  
  58. ==============================================================================
  59. Distribution
  60. ==============================================================================
  61.  
  62. You may redistribute this program provided that you include the original,
  63. unmodified application and readme files and NOTHING ELSE.  You may charge
  64. duplication fees for distributing this program, but your fee may not exceed
  65. the basic cost of media duplication (you are not allowed to make money by
  66. distributing OPE). You may place this program on an online service as long
  67. as downloading the file incurs only standard connection charges).  
  68.  
  69. DO NOT DISTRIBUTE OBJECT PLACEMENT EDITOR (OPE) TO THE FOLLOWING SITES:
  70. sumex-aim.stanford.edu
  71. ftp.amug.org
  72. America Online (Macintosh Games Forum)
  73.  
  74. I will update these three sites myself, so please don't send them extra copies.
  75.  
  76. The author specifically grants permission to the maintainers of the
  77. archives at Sumex-Aim.stanford.edu to include this program on the CD-ROM
  78. distribution of the archive.
  79.  
  80. The author specifically grants permission to SOFTBANK Corporation to include
  81. this program on its supplemental applications disk bundled with MacUser
  82. Japanese Edition.
  83.  
  84. ==============================================================================
  85. How to get new versions
  86. ==============================================================================
  87.  
  88. I will post release versions to sumex-aim.stanford.edu, America Online (Mac
  89. Games Forum) and ftp.amug.org.  You can get releases and prereleases (not
  90. for redistribution) from one of my web pages:
  91.  
  92. http://www.amug.org/~marathon/ope/
  93. http://emb121.rh.psu.edu/marathon/marathon.html
  94.  
  95. The second site is my personal machine and is not availabe during the summer
  96. or during semester breaks.  Please try AMUG first.
  97.  
  98. ==============================================================================
  99. Special Considerations--READ BEFORE USING!
  100. ==============================================================================
  101.  
  102. You should NEVER have to change the amount of memory allocated to OPE in the
  103. Finder.  If OPE needs more memory, it will obtain it from the system software.
  104. In other words, if you open a 3.5 meg map file and OPE has only its standard
  105. 391k of memory, your system software will expand to use an additional 3.5 megs
  106. of RAM.  "About this Macintosh..." under the Apple menu in the Finder will
  107. reflect this increase in memory use.  As soon as you close your file in OPE,
  108. the memory will be released for use by other applications.
  109.  
  110. You should be able to use maps from the Demo or the commercial release. If the
  111. format of your map file is not the same, this program will probably corrupt it.
  112.  
  113. This version of OPE cannot read Marathon 2 map files (previous versions could).
  114. Use OPE's companion program DOPE to edit M2 maps.
  115.  
  116. EDIT ONLY A BACKUP COPY OF YOUR MAP FILE.  This program is not based on solid
  117. information from Bungie; it uses information uncovered by Tom Klancer and
  118. myself.  Don't trust this program to work.
  119.  
  120.  
  121. ==============================================================================
  122. How to use OPE--Basic Editing
  123. ==============================================================================
  124.  
  125. After loading OPE, select "Open..." from the file menu and load your map (you
  126. can also drag-and-drop a map in the Finder).  OPE will scan the file for
  127. valid levels.
  128.  
  129. Now select the desired level under the "Levels" menu.
  130.  
  131. You can select which character/object you wish to edit by selecting it from
  132. the "Characters" or "Objects" menus.  In the main window, there are six
  133. edit fields:
  134.  
  135. -Placement method
  136.         If you place a 1 here, objects will be placed randomly on the level.  
  137.     Net levels work in this way.  Regular game levels have a zero, meaning that
  138.     aliens are placed in specific places on the level.  Changing the default
  139.     value on a given level from 0 to 1 should not cause problems, but I don't
  140.     know how Marathon responds when directed to placed objects in specific
  141.     locations when they're usually random.
  142.         If you use a value other than 0 or 1, OPE substitutes a 1 because 1 is
  143.     guaranteed to work.
  144. -Initial # of object
  145.         The object will be placed this many times on the level before game
  146.     play begins; objects are placed depending on the value of the first field.
  147. -Minimum #
  148.         Marathon will do its best to keep this amount of the object in play.
  149.     However, if you have nonrandom placement (first field) on and you ask for
  150.     more objects than the map has placement positions, Marathon may not be
  151.     able to replenish fast enough.
  152. -Max #
  153.         This represents the total number of the alien or object that can be
  154.     present on the level at once.  For example, a value of 10 in the record
  155.     for napalm canisters means that at most 10 canisters can be in play (held
  156.     by players or sitting on the floor) at any one time.  Or, suppose Min# of
  157.     missiles is 4 and Max# is 8; there will always be 4 missile packs in play,
  158.     and there may be up to 8 (the speed of the increase from 4 to 8
  159.     depends on the replenishment field; see below).  Note also that if Min# is
  160.     greater than Max# then Max# is irrelevant.
  161. -Extras
  162.         The total number of objects which Marathon will add over the course of the game
  163.     in addition to the minimum number which must always be there.  An example explains
  164.     this better: suppose Min# fighters is 2, Max# is 4, Extras is 10.  There will
  165.     always be at least 2 fighters; fighters will be added until up till four are present,
  166.     but only ten times--after this only the two required fighters will be present. Or
  167.     you can think of the Min# field as having precedence over the Extras field. 65535
  168.     supposedly represents infinite replenishment (as if anyone would play long enough
  169.     to exhaust 65534 items...).
  170. -Replenishment freq.
  171.         The higher the number, the more often Marathon will add the object in an attempt
  172.     to reach Max#.  Values are from 0-65535.
  173.  
  174. If you want none of an object, set both min# and max# to zero.
  175.  
  176. If you enter a value less than 0 or greater than 255 for Initial# or Max# or Min#, OPE
  177. will substitute ZERO.
  178.  
  179. To clear all characters or objects from the level, choose "Remove all aliens"
  180. or "Remove all objects" from the special menu. "Clear All Records" does both.
  181.  
  182.  
  183. ==============================================================================
  184. How to use OPE--Level Randomizer
  185. ==============================================================================
  186.  
  187. The Randomizer (in the Special Menu) is a quick way to generate new net 
  188. levels.  It clears all objects from the current level and then places
  189. new ones based on what frequency of the various type of objects you choose
  190. in the Randomizer window.
  191.  
  192. Some things you should be aware of:
  193. 1).  OPE usually instructs Marathon to place weapons in their predefined
  194.     locations, but if a level doesn't have a predefined spot for a weapon,
  195.     it will never appear.  To circumvent this problem you can check the
  196.     "Place weapons randomly" checkbox in the Randomizer window.
  197. 2).  Because randomly placing large aliens (juggernauts and, to a lesser
  198.     extent, hulks) can cause problems in levels with small closed spaces,
  199.     OPE instructs Marathon to place these aliens only in predefined map
  200.     locations (if the map contains no starting points for hulks and
  201.     juggernauts, none will appear).  If you really want these aliens
  202.     to appear randomly like everything else, you can make a really simple
  203.     change to OPE with ResEdit; see the "How OPE Works" file for instructions
  204.     on how to make the change (it's easy--honest!).
  205.     
  206. ==============================================================================
  207. How to use OPE--Sets
  208. ==============================================================================
  209.  
  210.     If you have several map configurations that you like to use, it's probably
  211. annoying to keep multiple large map files around just to preserve these
  212. configurations.  OPE can extract the object placement information from
  213. a map file and save it in a much smaller file, called a "set file."  This
  214. file records the placement information for EVERY LEVEL in the current map
  215. file, not just the level you're currently editing.
  216.  
  217.     Once you have a map file open in OPE, choose "New set..." from the Special
  218. menu.  OPE will ask you where to save the set.  The set file that results
  219. contains all of the information that OPE is capable of changing--the contents
  220. of the six edit fields in the main window for ALL entries in the Characters
  221. and Objects menus for ALL levels in the current map file.  When you want to
  222. put this object placement configuration back into your map file, simply load
  223. the map file, choose "Load set..." from the Special menu, and choose the
  224. desired set.
  225.  
  226.     OPE does not currently support drag-and-drop opening of set files.
  227.     
  228.     One set file called "Default Set" is included.  It contains the normal
  229. map setup that comes with Marathon.
  230.  
  231. ==============================================================================
  232. About the Included Files (in the "File Formats" directory)
  233. ==============================================================================
  234.  
  235. "How OPE works"            describes what I know about the "plac" section and
  236.                             tells you how to use ResEdit to customize
  237.                             OPE for new objects or to change the behavior
  238.                             of the Randomizer.
  239. "Map Editing"            a somewhat dated file with info on the map file
  240.                             (I did _not_ write this file)
  241. "Marathon File Specs"    file format info for several of Marathon's files.
  242.                             (I did _not_ write this file)
  243.  
  244.  
  245. ==============================================================================
  246. Version History
  247. ==============================================================================
  248. 12/31/95 -- version 1.4
  249.             Faster and more reliable level scanner.
  250.             Fixed a bug where the map file would be opened but never closed if
  251.                 there was not enough memory to load the map file.
  252.             Previous version sometimes allowed selecting "close" from the file
  253.                 menu when nothing was open, corrupting memory.
  254.  
  255. 6/07/95  -- version 1.32b
  256.             Fixed a really stupid omission in the "Sets" code; the program was
  257.             only saving and loading the placement info for the current level, 
  258.             not for all levels in the map file.  As a side effect, the 
  259.             "Default Set" included with 1.31b was incorrect.  If you have it,
  260.             toss it.
  261.  
  262. 5/30/95  -- version 1.31b
  263.             added "sets" capability
  264.             added a sanity check to make sure there is at least one valid
  265.                 level in any opened map file (if not, the file is left closed)
  266.  
  267. 03/18/95 -- version 1.3
  268.             the map file is now loaded into the system heap
  269.             added a portion of code which had miraculously vanished since
  270.                 version 1.12b--"Place weapons randomly" in the randomizer
  271.                 dialog
  272.             added level-scanning thermometer
  273.  
  274. 03/15/95 -- version 1.2
  275.             Added (yuck) custom icon; many people bugged me to use one :(.
  276.             Started checking for changes to the open file before closing it.
  277.             Added file open via drag-and-drop in the Finder.
  278.             Opened last two fields for editing.
  279.             Added level randomizer.
  280.             Added load/save/search cursor changes.
  281.             Changed (again!) fields descriptions.
  282.             You can now navigate edit fields with return, tab, and up/down.
  283.  
  284. 02/21/95 -- version 1.1.
  285.             Added editing of objects (added the "Objects" menu).
  286.             Fixed possible crash when Opening a locked file (Save still bombs).
  287.             Included information on Marathon file formats.
  288.             Added "Placement Method" field.
  289.         
  290. 02/11/95 -- version 1.0
  291.                First version; known as NetEdit.
  292.                Written in about 6 hours and possibly buggy :-)
  293.      
  294.  
  295.      
  296. What may appear in future releases:
  297.  
  298.     - PackBits compression of set files.
  299.     - Drag & Drop support for set files.
  300.     - better error handling (for example, OPE currently bombs on locked files)
  301.     - a window containing a summary of all objects currently on the level
  302.            being edited
  303.     - pictures of the aliens and objects
  304.     - a more intelligent randomizer
  305.  
  306.  
  307. What will NOT appear in future releases:
  308.  
  309.     - full-fledged map editing
  310.  
  311.  
  312. ==============================================================================
  313. HOW TO REPORT BUGS
  314. ==============================================================================
  315.  
  316. If you find a bug, please figure out how to reproduce it, then send me a bug
  317. report at EricB@psu.edu or EricB@pobox.com.
  318.  
  319.  
  320. ==============================================================================
  321. Special Thanks
  322. ==============================================================================
  323.  
  324. Thanks go to:
  325.  
  326. -Tom Klancer     : provided information on the map file format
  327. -Bernie Freidin  : info on how to get level names properly
  328. -Staz Software   : publisher of FutureBasic
  329. -Bungie Software : hmmm... I forget what they did...
  330.  
  331.  
  332. Less specifically, thanks to everyone on the 'net who sent me suggestions for
  333. new features and icons etc.
  334.  
  335.  
  336. [end of file]
  337.